modo

type: module

doc: Abstract Base Classes (ABCs) for collections, according to PEP 3119. DON'T USE THIS MODULE DIRECTLY! The classes here should be imported via collections; they are defined here only to alleviate certain bootstrapping issues. Unit tests are in test_collections.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

type: function

doc: A decorator indicating abstract methods. Requires that the metaclass is ABCMeta or derived from it. A class that has a metaclass derived from ABCMeta cannot be instantiated unless all of its abstract methods are overridden. The abstract methods can be called using any of the normal 'super' call mechanisms. Usage: class C: __metaclass__ = ABCMeta @abstractmethod def my_abstract_method(self, ...): ...

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

type: module

doc: Heap queue algorithm (a.k.a. priority queue). Heaps are arrays for which a[k] <= a[2*k+1] and a[k] <= a[2*k+2] for all k, counting elements from 0. For the sake of comparison, non-existing elements are considered to be infinite. The interesting property of a heap is that a[0] is always its smallest element. Usage: heap = [] # creates an empty heap heappush(heap, item) # pushes a new item on the heap item = heappop(heap) # pops the smallest item from the heap item = heap[0] # smallest item on the heap without popping it heapify(x) # transforms list into a heap, in-place, in linear time item = heapreplace(heap, item) # pops and returns smallest item, and adds # new item; the heap size is unchanged Our API differs from textbook heap algorithms as follows: - We use 0-based indexing. This makes the relationship between the index for a node and the indexes for its children slightly less obvious, but is more suitable since Python uses 0-based indexing. - Our heappop() method returns the smallest item, not the largest. These two make it possible to view the heap as a regular Python list without surprises: heap[0] is the smallest item, and heap.sort() maintains the heap invariant!

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\heapq.pyc

type: builtin_function_or_method

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, reverse=True)[:n]

type: builtin_function_or_method

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable)[:n]

type: function

file: .\Lib\heapq.py

type: function

file: .\Lib\heapq.py

type: function

file: .\Lib\heapq.py

type: builtin_function_or_method

doc: Transform list into a heap, in-place, in O(len(heap)) time.

type: builtin_function_or_method

doc: Pop the smallest item off the heap, maintaining the heap invariant.

type: builtin_function_or_method

doc: Push item onto heap, maintaining the heap invariant.

type: builtin_function_or_method

doc: Push item on the heap, then pop and return the smallest item from the heap. The combined action runs more efficiently than heappush() followed by a separate call to heappop().

type: builtin_function_or_method

doc: Pop and return the current smallest value, and add the new item. This is more efficient than heappop() followed by heappush(), and can be more appropriate when using a fixed-size heap. Note that the value returned may be larger than item! That constrains reasonable uses of this routine unless written as part of a conditional replacement: if item > heap[0]: item = heapreplace(heap, item)

type: function

doc: Merge multiple sorted inputs into a single sorted output. Similar to sorted(itertools.chain(*iterables)) but returns a generator, does not pull the data into memory all at once, and assumes that each of the input streams is already sorted (smallest to largest). >>> list(merge([1,3,5,7], [0,2,4,8], [5,10,15,20], [], [25])) [0, 1, 2, 3, 4, 5, 5, 7, 8, 10, 15, 20, 25]

file: .\Lib\heapq.py

type: function

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, key=key, reverse=True)[:n]

file: .\Lib\heapq.py

type: function

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable, key=key)[:n]

file: .\Lib\heapq.py

type: builtin_function_or_method

doc: tee(iterable, n=2) --> tuple of n independent iterators.

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

type: type

doc: starmap(function, sequence) --> starmap object Return an iterator whose values are returned from the function evaluated with a argument tuple taken from the given sequence.

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

type: TypeError

doc: Inappropriate argument type.

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

type: SESysStdErr

type: SESysStdIn

type: SESysStdOut

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

type: version_info

doc: sys.version_info Version information as a named tuple.

type: type

doc: Dict subclass for counting hashable items. Sometimes called a bag or multiset. Elements are stored as dictionary keys and their counts are stored as dictionary values. >>> c = Counter('abcdeabcdabcaba') # count elements from a string >>> c.most_common(3) # three most common elements [('a', 5), ('b', 4), ('c', 3)] >>> sorted(c) # list all unique elements ['a', 'b', 'c', 'd', 'e'] >>> ''.join(sorted(c.elements())) # list elements with repetitions 'aaaaabbbbcccdde' >>> sum(c.values()) # total of all counts 15 >>> c['a'] # count of letter 'a' 5 >>> for elem in 'shazam': # update counts from an iterable ... c[elem] += 1 # by adding 1 to each element's count >>> c['a'] # now there are seven 'a' 7 >>> del c['b'] # remove all 'b' >>> c['b'] # now there are zero 'b' 0 >>> d = Counter('simsalabim') # make another counter >>> c.update(d) # add in the second counter >>> c['a'] # now there are nine 'a' 9 >>> c.clear() # empty the counter >>> c Counter() Note: If a count is set to zero or reduced to zero, it will remain in the counter until the entry is deleted or the counter is cleared: >>> c = Counter('aaabbc') >>> c['b'] -= 2 # reduce the count of 'b' by two >>> c.most_common() # 'b' is still in, but its count is zero [('a', 3), ('c', 1), ('b', 0)]

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

type: instancemethod

doc: Return a shallow copy.

file: .\Lib\collections.py

type: instancemethod

doc: Iterator over elements repeating each as many times as its count. >>> c = Counter('ABCABC') >>> sorted(c.elements()) ['A', 'A', 'B', 'B', 'C', 'C'] # Knuth's example for prime factors of 1836: 2**2 * 3**3 * 17**1 >>> prime_factors = Counter({2: 2, 3: 3, 17: 1}) >>> product = 1 >>> for factor in prime_factors.elements(): # loop over factors ... product *= factor # and multiply them >>> product 1836 Note, if an element's count has been set to zero or is a negative number, elements() will ignore it.

file: .\Lib\collections.py

type: instancemethod

file: .\Lib\collections.py

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

type: method_descriptor

doc: D.keys() -> list of D's keys

type: instancemethod

doc: List the n most common elements and their counts from the most common to the least. If n is None, then list all element counts. >>> Counter('abcdeabcdabcaba').most_common(3) [('a', 5), ('b', 4), ('c', 3)]

file: .\Lib\collections.py

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

type: instancemethod

doc: Like dict.update() but subtracts counts instead of replacing them. Counts can be reduced below zero. Both the inputs and outputs are allowed to contain zero and negative counts. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.subtract('witch') # subtract elements from another iterable >>> c.subtract(Counter('watch')) # subtract elements from another counter >>> c['h'] # 2 in which, minus 1 in witch, minus 1 in watch 0 >>> c['w'] # 1 in which, minus 1 in witch, minus 1 in watch -1

file: .\Lib\collections.py

type: instancemethod

doc: Like dict.update() but add counts instead of replacing them. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.update('witch') # add elements from another iterable >>> d = Counter('watch') >>> c.update(d) # add elements from another counter >>> c['h'] # four 'h' in which, witch, and watch 4

file: .\Lib\collections.py

type: method_descriptor

doc: D.values() -> list of D's values

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

type: type

doc: defaultdict(default_factory) --> dict with default factory The default factory is called without arguments to produce a new value when a key is not present, in __getitem__ only. A defaultdict compares equal to a dict with the same items.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

type: method_descriptor

doc: D.copy() -> a shallow copy of D.

type: member_descriptor

doc: Factory for default value called by __missing__().

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

type: method_descriptor

doc: D.keys() -> list of D's keys

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

type: method_descriptor

doc: D.values() -> list of D's values

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

type: type

doc: deque(iterable[, maxlen]) --> deque object Build an ordered collection with optimized access from its endpoints.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

type: method_descriptor

doc: Add an element to the right side of the deque.

type: method_descriptor

doc: Add an element to the left side of the deque.

type: method_descriptor

doc: Remove all elements from the deque.

type: method_descriptor

doc: D.count(value) -> integer -- return number of occurrences of value

type: method_descriptor

doc: Extend the right side of the deque with elements from the iterable

type: method_descriptor

doc: Extend the left side of the deque with elements from the iterable

type: getset_descriptor

doc: maximum size of a deque or None if unbounded

type: method_descriptor

doc: Remove and return the rightmost element.

type: method_descriptor

doc: Remove and return the leftmost element.

type: method_descriptor

doc: D.remove(value) -- remove first occurrence of value.

type: method_descriptor

doc: D.reverse() -- reverse *IN PLACE*

type: method_descriptor

doc: Rotate the deque n steps to the right (default n=1). If n is negative, rotates left.

type: type

doc: Dictionary that remembers insertion order

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

type: object

doc: The most base type

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

type: instancemethod

doc: od.clear() -> None. Remove all items from od.

file: .\Lib\collections.py

type: instancemethod

doc: od.copy() -> a shallow copy of od

file: .\Lib\collections.py

type: instancemethod

doc: OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S. If not specified, the value defaults to None.

file: .\Lib\collections.py

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

type: instancemethod

doc: od.items() -> list of (key, value) pairs in od

file: .\Lib\collections.py

type: instancemethod

doc: od.iteritems -> an iterator over the (key, value) pairs in od

file: .\Lib\collections.py

type: instancemethod

doc: od.iterkeys() -> an iterator over the keys in od

file: .\Lib\collections.py

type: instancemethod

doc: od.itervalues -> an iterator over the values in od

file: .\Lib\collections.py

type: instancemethod

doc: od.keys() -> list of keys in od

file: .\Lib\collections.py

type: instancemethod

doc: od.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

file: .\Lib\collections.py

type: instancemethod

doc: od.popitem() -> (k, v), return and remove a (key, value) pair. Pairs are returned in LIFO order if last is true or FIFO order if false.

file: .\Lib\collections.py

type: instancemethod

doc: od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od

file: .\Lib\collections.py

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

type: instancemethod

doc: od.values() -> list of values in od

file: .\Lib\collections.py

type: instancemethod

doc: od.viewitems() -> a set-like object providing a view on od's items

file: .\Lib\collections.py

type: instancemethod

doc: od.viewkeys() -> a set-like object providing a view on od's keys

file: .\Lib\collections.py

type: instancemethod

doc: od.viewvalues() -> an object providing a view on od's values

file: .\Lib\collections.py

type: type

doc: partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

type: member_descriptor

doc: tuple of arguments to future partial calls

type: member_descriptor

doc: function object to use in future partial calls

type: member_descriptor

doc: dictionary of keyword arguments to future partial calls

type: type

doc: Action Clip and Render pass item. :param item: either an item of type 'actionclip' or an item name/ID to lookup. :type item: an instance of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: Set or get the active state of the render pass. :getter: Returns the active state of the render pass. :rtype: bool :setter: Sets the active state of the renter pass :param state: active state. :type state: bool

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: Get or set the enabled state of the render pass. :getter: Returns the enabled state. :rtype: bool :setter: Sets the enabled state of the render pass :param state: enabled state. :type state: bool

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Read a value set on a channel for this render pass. :param chan: the channel to read the value from. :type chan: modo.channel.Channel object :param time: the time (in seconds) to read the value for, defaults to 0.0. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

type: property

doc: :getter: Returns the internal Modo item embedded in this object

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: Name of the render pass. :getter: Returns the name of the render pass :rtype: basestring :setter: Assigns a new name to the render pass :param name: new name for the render pass. :type name: basestring

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

type: property

doc: The render pass group that the render pass belongs to. :getter: Returns the render pass group :rtype: modo.item.RenderPassGroup :setter: Sets the render pass group :param group: render pass group to parent to. :type group: modo.item.RenderPassGroup

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Set a value on a channel for this render pass. :param chan: the channel to set the value on. :type chan: modo.channel.Channel object :param value: the value to set for the channel. :type value: any :param time: the time (in seconds) to set the value for, defaults to 0.0. :type time: float :param key: whether to set a key for the value or not, defaults to False. :param key: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

type: type

doc: Wrapper class for actor groups.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

type: instancemethod

doc: Adds an action to this actor Note: please avoid naming actions 'setup', 'edit' or 'scene' :returns ActionClip: ActionClip :param basestring name: Optional name for the action

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Adds a pose to this actor :returns ActionClip: ActionClip :param basestring name: Optional name for the pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

type: property

doc: :getter: Returns the currently active action if any. None if no action is active :rtype: ActionClip

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

type: property

doc: :getter: Returns the internal Modo item embedded in this object

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

type: property

doc: :getter: Returns a list of LocatorSuperType items that are connected to this action. :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

type: instancemethod

doc: Return a pose by name :param basestring poseName: Name of the pose to look up :returns: Pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

type: type

doc: Area light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Area Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. :param light: Optional area light item object (type lx.symbol.sITYPE_AREALIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid area light item selected. :raises TypeError: if the item passed as an argument isn't either an area light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

type: property

doc: :getter: Returns the internal Modo item embedded in this object

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

type: property

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

type: type

doc: Camera item class. Takes an optional 'camera' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'camera' or an item name or ID to look up. If no camera item is supplied as an argument an attempt will be made to wrap the most recently selected camera. :param camera: Optional camera item object (type lx.symbol.sITYPE_CAMERA) or string (item name or ID) to look up. :type camera: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid camera item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'camera' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the camera argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

type: property

doc: :getter: Returns the internal Modo item embedded in this object

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

type: property

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Add a link between this channel and another. :param to_channel: The channel to link to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Delete a link from the channel graph. :param to_channel: The channel the link is to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Removes an input connection from another channel if it exists. :param Channel other: Other channel to disconnect from. If it is None, all input connections are removed.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: property

doc: Returns the channel's animation envelope. :getter: Returns the channel's animation envelope. :rtype: modo.channel.Envelope :raises LookupError: if the channel isn't animated.

type: property

doc: Returns the evaluation type of a channel, which is the type of slot allocated in the eval state vector. This will return the "gradstack" exo-type for gradient channels. :getter: Returns the evaluation type of the channel :rtype: basestring

type: instancemethod

doc: Returns the linked channel at the specified index forward of this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index forward of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: property

doc: Returns the number of linked channels forward of this channel in this channel graph. :getter: Returns the number of linked channels forward of this channel in this channel graph. :rtype: int

type: property

doc: Returns a list of the linked channels forward of this channel in the channel graph. :getter: Returns the forward channels in this item's channel graph. :rtype: list

type: instancemethod

doc: Returns a channel's value for an action at a specific time. Defaults to reading the channel's evaluated value at the current time. :param time: Optional time in seconds to read the value at. :type time: float :param action: The action to read the value from. Defaults to None (evaluation). :type action: basestring :returns: the channel's value. :rtype: depends on the type of the channel being read.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: property

doc: The channel's channel graph. :getter: Returns the channel's channel graph. :rtype: lxu.object.ChannelGraph

type: property

doc: The channel's index. :getter: Returns the channel's index. :rtype: int

type: property

doc: Returns whether the channel is animated. :getter: Returns whether the channel is animated or not. :rtype: bool

type: property

doc: :getter: Returns the item that is associated with this channel :rtype: Item

type: property

doc: The channel's name. :getter: Returns the channel's name. :rtype: basestring

type: property

doc: Returns the number of linked channels that occur before this channel in the channel graph. :getter: Returns the number of linked channels that occur before this channel in the channel graph. :rtype: int

type: instancemethod

doc: Returns the linked channel at the specified index before this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index before of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: property

doc: Returns a list of the linked channels that appear before this channel in the channel graph. :getter: Returns the linked channels that appear before this channel in the channel graph. :rtype: list

type: instancemethod

doc: Sets a channel's value for an action at a specific time. Defaults to setting the channel's value for the "edit" action and at the current time. :param value: The value to set for the channel. :type value: depends on the type of the channel :param time: optional time in seconds to set the value for. :type time: float :param key: Specifies whether to set a key for the channel. :type key: bool :param action: The action to set the value on. :type action: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Set a link's position (from index, to index) in the channel graph. :param from_index: The index in the channel graph for the current (from) channel. :type from_index: int :param to_channel: The to channel. :type to_channel: modo.channel.Channel :param to_index: the index in the channel graph for the 'to' channel. :type to_index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: property

doc: Returns the storage type of the channel, which can be valid exo-type name for numeric and stored custom types or None if no storage type is found. :getter: Returns the channel storage type :rtype: basestring

type: property

doc: Returns the channel type. The numeric and gradient types can be keyframed. The return type is an int which translates to the following types: | 0: none | 1: integer | 2: float | 3: gradient | 4: storage | 5: eval :getter: Returns the channel type. :rtype: int

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: type

doc: Wrapper to allow setting and reading all three channels on a vector 'channel' at once :param basestring channelName: The channel name. eg 'diffCol' :param modo.item.Item item: The item the channel belongs to. :raises: LookUpError if no respective channel of the given name was found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Same arguments as Channel.get()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Sets three values for the three channels at once :param float time: Time in seconds for the value to be set at (optional) :param basestring action: Action to set the value for (optional)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: type

doc: Cylinder light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Cylinder Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Cylinder Light item. :param light: Optional Cylinder light item object (type lx.symbol.sITYPE_CYLINDERLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid cylinder light item selected. :raises TypeError: if the item passed as an argument isn't either a cylinder light or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

type: property

doc: :getter: Returns the internal Modo item embedded in this object

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

type: property

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

type: property

doc: :getter: Returns the internal Modo item embedded in this object

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a list of connected meshes

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

type: property

doc: :getter: Returns the number of meshes connected to this deformer

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

type: Deformer

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

type: instancemethod

doc: Connects an influence deformer into this deformGroup :param other:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

type: property

doc: :getter: Returns the internal Modo item embedded in this object

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

type: type

doc: Directional light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Directional Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Directional Light item. :param light: Optional Directional light item object (type lx.symbol.sITYPE_SUNLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid directional light item selected. :raises TypeError: if the item passed as an argument isn't either a Directional light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple